@types/lru-cache

What is @types/lru-cache?

The @types/lru-cache package provides TypeScript type definitions for the lru-cache package, enabling developers to use LRU (Least Recently Used) caching mechanism in TypeScript projects with type checking. This package does not implement LRU cache logic itself but offers type support for the lru-cache package, ensuring that developers can work with clear and predictable type definitions for better code quality and maintainability.

What are @types/lru-cache's main functionalities?

Creating an LRU Cache

This code demonstrates how to create an LRU cache instance with a maximum of 100 items and items expiring after an hour. The cache keys are of type string, and the values can be of any type.

import LRU from 'lru-cache';

const options = {
  max: 100,
  maxAge: 1000 * 60 * 60
};

const cache = new LRU<string, any>(options);

Setting and Getting Cache Items

This code snippet shows how to set a value in the cache with a specific key and then retrieve that value using the key. The 'set' method adds or updates an entry, and the 'get' method retrieves an entry if it exists and is not expired.

cache.set('key', 'value');
const value = cache.get('key');

Checking if a Key Exists

This example demonstrates checking if a specific key exists in the cache without updating the recent-ness or expiration of the item.

const hasKey = cache.has('key');

Deleting a Cache Item

This code sample illustrates how to delete a specific item from the cache using its key.

cache.del('key');

Other packages similar to @types/lru-cache

node-cache

node-cache is a simple caching module for Node.js that offers in-memory storage. Unlike lru-cache, it does not inherently support LRU eviction policy but provides a straightforward API for key-value storage with TTL support.

memory-cache

memory-cache is another simple in-memory cache for Node.js applications. It provides basic functionality similar to node-cache and does not specifically implement LRU logic, focusing instead on simplicity and ease of use.

quick-lru

quick-lru is a fast and efficient LRU cache implementation. It offers a similar LRU caching mechanism to lru-cache but focuses on performance and simplicity, with a minimalistic API and optimized operations for high-speed caching scenarios.

README

Installation

npm install --save @types/lru-cache

Summary

This package contains type definitions for lru-cache (https://github.com/isaacs/node-lru-cache).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lru-cache.

Additional Details

• Last updated: Tue, 06 Jul 2021 22:02:58 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Bart van der Schoor, and BendingBender.